/**
 * Copyright (c) 2009 Blue Whale Systems Ltd
 * 
 * This software is provided "as is," and the copyright holder makes no representations or warranties, express or
 * implied, including but not limited to warranties of merchantability or fitness for any particular purpose or that the
 * use of this software or documentation will not infringe any third party patents, copyrights, trademarks or other
 * rights.
 * 
 * The copyright holder will not be liable for any direct, indirect special or consequential damages arising out of any
 * use of this software or documentation.
 */
package com.bluewhalesystems.client.lwuit.richtext;

/**
 * Represents the interface and the base 'plain text' implementation for objects that generate 'formatted data' to be
 * displayed by a {@link com.sun.lwuit.RichTextArea} component.
 * 
 * 'Formatted data' consists of version indicator (a single character) followed by the textual content interspersed
 * with 'control sequences'. This data is then prepared for rendering by {@link LineDataGenerator}.
 */
public interface FormattedDataGenerator
{
    /**
     * Returns a 'formatted' representation of textual data.
     * 
     * @return 'formatted' character data or null
     */
    GrowableCharArray getFormattedData();
}
